home *** CD-ROM | disk | FTP | other *** search
/ Aminet 28 / Aminet 28 (1998)(GTI - Schatztruhe)[!][Dec 1998].iso / Aminet / dev / debug / 2b_MungFriend.lha / MungFriend3.7.doc < prev   
Encoding:
Text File  |  1998-09-11  |  6.2 KB  |  281 lines
  1.                                 Mungfriend 3.7
  2.                      © 1995-98 Szymon Pura, David Zaroski
  3.                                    FREEWARE
  4.                                 BLABLA PRODUCT
  5.  
  6. ============
  7. INTRODUCTION
  8. ============
  9.  
  10.   MungFriend   is   a   tool   for  capturing  raw  serial  output  (done  via
  11.   exec/RawPutChar(),  kprintf).   It installs a resident (reset-proof) buffer,
  12.   so  it  can  survive  most  GURUs.   Especially  useful  for  debugging with
  13.   Mungwall, Enforcer etc.
  14.   Mungfriend is a replacement for Commodore's Sushi.
  15.  
  16. =====
  17. USAGE
  18. =====
  19.  
  20.   MungFriend <command> [<command args>] [options]
  21.  
  22.    <commands> are:          Shortcut:
  23.  
  24.   -  INFO                      I
  25.   -  INSTALL                   S
  26.   -  CLEAR                     C
  27.   -  REMOVE                    R
  28.   -  TYPE                      T
  29.   -  UPDATE                    U
  30.   -  WRITE                     W
  31.  
  32.   <command args> are:
  33.  
  34.   - SIZE <n>     where <n> is a decimal number (only for INSTALL)
  35.   - [TO] <f>       where <f> is a filename      (only for WRITE)
  36.  
  37.   <options> are:
  38.  
  39.   - FLASH / NOFLASH
  40.   - TRACE / NOTRACE
  41.   - SERIAL /  NOSERIAL
  42.   - BELLS / NOBELLS
  43.  
  44.  
  45.  (It seems complicated, but you'll be able to get hang of it in a second)
  46.  
  47.  
  48.  
  49. 1. CREATING MUNGFRIEND BUFFER
  50.  
  51.   MungFriend install size <n>  ; <n> - size of buffer (in bytes)
  52.  
  53.  Example:
  54.  
  55.   MungFriend install size 15000 ; allocate ~15 KB of a reset-proof buffer.
  56.  
  57.  Notes:
  58.  
  59.   You can't change size of buffer after installing - you must remove
  60.   previous buffer first.
  61.  
  62.  
  63. 2. REMOVING MUNGFRIEND BUFFER
  64.  
  65.   MungFriend remove
  66.  
  67.  Removes the previously allocated buffer (see above).
  68.  
  69. Notes:
  70.  
  71.   Since V3.7, the buffer will NOT be free'd immediately. I don't think there is
  72.  a Kick 2.0-3.1 compatible way to do this.
  73.  
  74.  
  75. 3. CLEARING BUFFER
  76.  
  77.   MungFriend clear
  78.  
  79.  Previous buffer contents are cleared.
  80.  
  81.  
  82. 4. TYPE
  83.  
  84.   Mungfriend type
  85.  
  86.  Types contents of the current buffer on the screen.
  87.  
  88.  (New for V3.1): press CTRL-C to stop.
  89.  
  90.  
  91. 5. WRITE
  92.  
  93.   Mungfriend write [to] <f> ; <f> is a filename.
  94.  
  95.  Example:
  96.  
  97.   MungFriend write to Ram:MungFriendReport
  98.  
  99.  Creates a new file (called Ram:MungFriendReport) and copies current buffer
  100.  contents to it.
  101.  
  102.  
  103.  
  104. 6. UPDATE
  105.  
  106.   Mungfriend update <options>
  107.  
  108.  Examples:
  109.  
  110.   Mungfriend update FLASH TRACE NOSERIAL
  111.   Mungfriend update SERIAL NOTRACE BELLS FLASH
  112.  
  113.  Just updates the options specified.
  114.  
  115.  Note well:
  116.  
  117.   You can specify options with EVERY command, not just with UPDATE.
  118.  
  119.  
  120.  
  121.  OPTIONS AVAILABLE:
  122.  
  123. 1. SERIAL/NOSERIAL
  124.  
  125.  If NOSERIAL is on, then all raw serial output (via exec/RawPutChar())
  126.  will be blocked. (i.e. even if there's a printer connected to the
  127.  serial port, it won't receive any data. However, MungFriend will
  128.  still be able to catch them in its buffer. You should normally
  129.  turn NOSERIAL on if you don't have a printer (for speed reasons)).
  130.  serial.device isn't affected by this option (again, only low-level
  131.  raw output via exec debugging functions is)
  132.  
  133. 2. TRACE/NOTRACE
  134.  
  135.  Most important option. If TRACE is on, then MungFriend will catch serial
  136.  output into its buffer.
  137.  
  138.  NOTE WELL: THIS OPTION GETS DISABLED AFTER RESET !!
  139.  After every reset or GURU 'TRACE' gets disabled. To continoue tracing,
  140.  you have to turn it back on. Use something like: MungFriend update trace
  141.  
  142. 3. FLASH/NOFLASH
  143.  
  144.  If FLASH is on, then every byte going through the raw serial will cause
  145.  the screen to flash. This way you won't miss any debugging output.
  146.  (I guess this won't work on most GFX boards)
  147.  
  148. 4. BELLS/NOBELLS
  149.  
  150.  If NOBELLS is on, then all console bells will be filtered out.
  151.  (Especially MungWall's and Enforcer's reports are full of those).
  152.  
  153. =======
  154. EXAMPLE
  155. =======
  156.  
  157.  Simple DOS script:
  158.  
  159.  MungFriend install size 15000 trace flash nobells noserial
  160.  Run Mungwall task all showfail nametag
  161.  Run Enforcer deadly showpc rawio buffersize 5000
  162.  
  163.  When the screen flashes, new characters were catched into the buffer.
  164.  Use the following command to check:
  165.  
  166.  MungFriend type
  167.  
  168.  
  169. =========
  170. TECHNICAL
  171. =========
  172.  
  173.  Kickstart V36+ (Release 2.0) required
  174.  
  175.  Assembler source included _ONLY_FOR_LEARNING_PURPOSES_
  176.  Source is meant to be an example (at least a bad one).
  177.  You are _NOT_ allowed to modify or assemble the source file.
  178.  
  179. =======
  180. CHANGES
  181. =======
  182.  
  183.  V3.7  -   09-09-98
  184.  -------------------
  185.  
  186.  o another bug fixed
  187.  o now the buffer won't be returned to memory pool after 'remove'. There seem to
  188.    be problems with free'ing AllcAbs()'ed memory...
  189.  
  190.  V3.6  -   27-02-98
  191.  -------------------
  192.  
  193.  o a great deal of bugs fixed
  194.  
  195.  V3.5  -   22-Dec-97
  196.  --------------------
  197.  
  198.   o casual Enforcer hit removed
  199.  
  200.  V3.4  -   18-Oct-97
  201.  --------------------
  202.  
  203.   o a major bug fixed - the WRITE command didn't check the buffer
  204.     correctly
  205.  
  206.  V3.3  -   02-Oct-97
  207.  --------------------
  208.  
  209.   o a litle bug removed
  210.   o syntax-info text changed
  211.  
  212.  V3.2  -   01-Sep-97
  213.  --------------------
  214.  
  215.   o some code cleanup
  216.   o a pesky bug removed
  217.  
  218.  V3.1a -   22-Feb-97
  219.  --------------------
  220.  
  221.   o problems with MEMF_KICK (under 2.0 and 2.04) fixed
  222.   o minor bugfix in INSTALL
  223.  
  224.  V3.1  -   20-Jan-97
  225.  --------------------
  226.  
  227.   o pressing CTRL-C during TYPE or WRITE will stop the command
  228.   o a tiny change in patch routine - should be slightly faster now
  229.   o added a trailing NULL to the ROMTag node structure
  230.   o now CPU caches are cleared during INSTALL
  231.  
  232.  V3.0  -  19-Nov-96
  233.  --------------------
  234.  
  235.   o totally redone memory allocation and KickMem/KickTag handling
  236.   o INFO improved
  237.   o some minor bugfixes and other minor changes
  238.  
  239.  V2.3  -  17-Nov-96
  240.  --------------------
  241.  
  242.   o major bug fixed in startup routine
  243.   o memory allocation was completely broken - changed to simple KickMem
  244.  
  245.  V2.2  -  26-Jun-96
  246.  --------------------
  247.  
  248.   o BELLS/NOBELLS option added
  249.  
  250.  V2.1  -  27-May-96
  251.  --------------------
  252.  
  253.   o LOADS of little bugs fixed
  254.  
  255.  V2.0  -  28-Feb-96
  256.  --------------------
  257.  
  258.   o now rewritten for OS 2.0+
  259.  
  260.  V1.0  -  19-Sep-95
  261.  --------------------
  262.  
  263.   o initial version
  264.  
  265.  
  266. ======
  267. AUTHOR
  268. ======
  269.  
  270.  MungFriend is FREEWARE. Use it at your own risk. It may be freely
  271.  distributed in its ORIGINAL, umodified form. Under NO CICRUMSTANCES
  272.  will the author be liable for any direct or indirect damage or data loss
  273.  resulting from the use or misuse of this software.
  274.  
  275.  All suggestions/bug reports/donations are welcome.
  276.  
  277.                                  Szymon Pura
  278.                               szymp@friko.onet.pl
  279.                              friko.onet.pl/cz/szymp
  280.  
  281.